Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/metrics controller #23

Merged
merged 7 commits into from
Jul 18, 2024
Merged

Feat/metrics controller #23

merged 7 commits into from
Jul 18, 2024

Conversation

0xnigir1
Copy link
Collaborator

@0xnigir1 0xnigir1 commented Jul 12, 2024

🤖 Linear

Closes ZKS-60 ZKS-61

Description

Adds Metrics controller with eps:

  • GET /metrics/ecosystem
  • GET /metrics/zkchain/{chainId}

Both return mocked data

@0xnigir1 0xnigir1 requested a review from 0xkenj1 July 12, 2024 14:49
Copy link

linear bot commented Jul 12, 2024

ZKS-60 Metrics controller

Implement Metrics defined in Notion tech-design doc. And make them retrieve mock data

https://www.notion.so/defi-wonderland/ZKchainHub-v2-Offchain-Tech-design-ea5302e63f0d456c89780b51e1cc3b54?pvs=4

Copy link

linear bot commented Jul 12, 2024

ZKS-61 Unit tests

Copy link
Collaborator

@0xkenj1 0xkenj1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we include natspec for all Modules, Services, Interfaces, DTO's? Is something that we are missing and is very important

@0xnigir1 0xnigir1 requested review from 0xkenj1 and 0xyaco July 17, 2024 17:21
Comment on lines 19 to 21
afterAll(async () => {
await app.close();
});
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any performance reason, or something like that, for this not to be an afterEach?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice catch 😅

Copy link
Collaborator

@0xkenj1 0xkenj1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GJ! Wdyt about removing NatSpec for constructor methods? At least for DTOs, I noticed that we are not going to have complex logic there, so I find it a bit redundant to have NatSpec for that.

@@ -3,10 +3,11 @@ import { ProvidersModule } from "@packages/providers";

import { ApiController } from "./api.controller";
import { RequestLoggerMiddleware } from "./common/middleware/request.middleware";
import { MetricsController } from "./metrics/metrics.controller";

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

natspec missing here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on this .module you say we add the Natspec due to the consumer applied? because in general .module doesn't have anything to be documented

@0xnigir1 0xnigir1 requested a review from 0xkenj1 July 18, 2024 13:23
@0xnigir1 0xnigir1 merged commit 7fd8e24 into dev Jul 18, 2024
6 checks passed
@0xnigir1 0xnigir1 deleted the feat/metrics-controller branch July 18, 2024 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants